﻿
using BCCommon;
using BCCommon.Enums;
using BCData.HelpDocument.HelpDocumentation;
using BCDto.HelpDocument.HelpDocumentation;
using BCDto.Sim.Admin.Admin;
using BCEntity.HelpDocument.HelpDocumentation;
using BCService.Utils;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BCService.HelpDocument.HelpDocumentation
{
    /// <summary>
    /// 帮助
    /// </summary>
    public interface IHelpDocumentationService
    {
        #region  成员方法
        /// <summary>
        /// 是否存在此记录
        /// </summary>
        /// <param name="helpDocumentationId">帮助文档</param>
        bool Exists(long helpDocumentationId);
        /// <summary>
        /// 是否存在此记录
        /// </summary>
        /// <param name="documentCode">帮助文档码</param>
        bool Exists(string documentCode);
        /// <summary>
        /// 添加帮助
        /// </summary>
        /// <param name="requestDto">帮助信息</param>
        /// <param name="adminDto"></param>
        HelpDocumentationDto Add(HelpDocumentationRequestDto requestDto, AdminDto adminDto);
        /// <summary>
        /// 更新帮助
        /// </summary>
        /// <param name="putDto">帮助信息</param>
        /// <param name="adminDto"></param>
        HelpDocumentationDto Update(HelpDocumentationPutDto putDto, AdminDto adminDto);
        /// <summary>
        /// 删除帮助
        /// </summary>
        /// <param name="helpDocumentationId">帮助文档</param>
        bool Delete(long helpDocumentationId);
        /// <summary>
        /// 获取帮助
        /// </summary>
        /// <param name="helpDocumentationId">帮助文档</param>
        HelpDocumentationDto Get(long helpDocumentationId);
        /// <summary>
        /// 获取帮助
        /// </summary>
        /// <param name="documentCode">帮助文档编码</param>
        HelpDocumentationDto Get(string documentCode);
        /// <summary>
        /// 获取帮助列表
        /// </summary>
        /// <param name="helpDocumentCategoryId">帮助文档分类Id</param>
        IEnumerable<HelpDocumentationDto> GetList(long helpDocumentCategoryId);
        /// <summary>
        /// 获取帮助分页列表
        /// </summary>
        /// <param name="helpDocumentCategoryId">帮助文档分类Id</param>
        /// <param name="searchKey">查询内容</param>
        /// <param name="start">开始时间</param>
        /// <param name="end">结束时间</param>
        /// <param name="sortName">排序字段</param>
        /// <param name="ascending">升序</param>
        /// <param name="pageIndex">当前页码</param>
        /// <param name="pageSize">帮助每页数据条数</param>
        PageableList<HelpDocumentationDto> Query(long? helpDocumentCategoryId, string searchKey, DateTime? start, DateTime? end, string sortName, bool? ascending, int pageIndex, int pageSize);
        #endregion  成员方法
    }
}